sdk/samples/all in on code/Visual Studio 2008/CSVSPackageStatusBar/MyControl.cs

   1 /***************************************** Module Header *****************************\
   2 * Module Name:  MyControl.cs
   3 * Project:      CSVSPackageStatusBar
   4 * Copyright (c) Microsoft Corporation.
   5 *
   6 * In this sample, we will demo:
   7 * 1. Write highlighted text in feedback region
   8 * 2. Read text from feedback region
   9 * 3. Show progress bar in status bar
  10 * 4. Show animation in the status bar
  11 * 5. Write row, column and char to designer region
  12 *
  13 * This source is subject to the Microsoft Public License.
  14 * See http://www.microsoft.com/opensource/licenses.mspx#Ms-PL.
  15 * All other rights reserved.
  16 *
  17 * History:
  18 * * 02/26/2010 04:35 PM Hongye Sun Created
  19 \*************************************************************************************/
  20
  21 using System.Security.Permissions;
  22 using System.Windows.Forms;
  23 using Microsoft.VisualStudio.Shell.Interop;
  24
  25 namespace Company.CSVSPackageStatusBar
  26 {
  27     /// <summary>
  28     /// Summary description for MyControl.
  29     /// </summary>
  30     public partial class MyControl : UserControl
  31     {
  32         public MyControl()
  33         {
  34             InitializeComponent();
  35         }
  36
  37         public IVsStatusbar SvcStatusBar { get; set; }
  38
  39         /// <summary>
  40         /// Let this control process the mnemonics.
  41         /// </summary>
  42         [UIPermission(SecurityAction.LinkDemand, Window = UIPermissionWindow.AllWindows)]
  43         protected override bool ProcessDialogChar(char charCode)
  44         {
  45               // If we're the top-level form or control, we need to do the mnemonic handling
  46               if (charCode != ' ' && ProcessMnemonic(charCode))
  47               {
  48                     return true;
  49               }
  50               return base.ProcessDialogChar(charCode);
  51         }
  52
  53         /// <summary>
  54         /// Enable the IME status handling for this control.
  55         /// </summary>
  56         protected override bool CanEnableIme
  57         {
  58             get
  59             {
  60                 return true;
  61             }
  62         }
  63
  64         private void btnWriteFeedback_Click(object sender, System.EventArgs e)
  65         {
  66             // Checks to see if the status bar is frozen
  67             // by calling the IsFrozen method.
  68             int frozen;
  69             SvcStatusBar.IsFrozen(out frozen);
  70             if (frozen == 0)
  71             {
  72                 // SetColorText only displays white text on a
  73                 // dark blue background.
  74                 SvcStatusBar.SetColorText("Here's some highlighted text", 0, 0);
  75                 System.Windows.Forms.MessageBox.Show("Pause");
  76                 SvcStatusBar.SetText("Done");
  77             }
  78         }
  79
  80         private void btnReadFeedback_Click(object sender, System.EventArgs e)
  81         {
  82             // Retrieve the status bar text.
  83             string text;
  84             SvcStatusBar.GetText(out text);
  85             System.Windows.Forms.MessageBox.Show(text);
  86
  87             // Clear the status bar text.
  88             SvcStatusBar.FreezeOutput(0);
  89             SvcStatusBar.Clear();
  90         }
  91
  92         private void btnShowProgressBar_Click(object sender, System.EventArgs e)
  93         {
  94             uint cookie = 0;
  95             string label = "Progress bar label...";
  96
  97             // Initialize the progress bar.
  98             SvcStatusBar.Progress(ref cookie, 1, "", 0, 0);
  99
 100             for (uint i = 0, total = 100; i <= total; i++)
 101             {
 102                 // Display incremental progress.
 103                 SvcStatusBar.Progress(ref cookie, 1, label, i, total);
 104                 System.Threading.Thread.Sleep(10);
 105             }
 106
 107             // Clear the progress bar.
 108             SvcStatusBar.Progress(ref cookie, 0, "", 0, 0);
 109         }
 110
 111         private void btnShowAnimation_Click(object sender, System.EventArgs e)
 112         {
 113             object icon =
 114                 (short)Microsoft.VisualStudio.Shell.Interop.Constants.SBAI_General;
 115
 116             // Display the animated Visual Studio icon in the Animation region.
 117             // Start the animation by calling the Animation method of the status bar.
 118             // Pass in 1 as the value of the first parameter, and a reference to an
 119             // animated icon as the value of the second parameter.
 120             SvcStatusBar.Animation(1, ref icon);
 121
 122             System.Windows.Forms.MessageBox.Show(
 123                 "Click OK to end status bar animation.");
 124
 125             // Stop the animation by calling the Animation method of the status bar.
 126             // Pass in 0 as the value of the first parameter, and a reference to the
 127             // animated icon as the value of the second parameter.
 128             SvcStatusBar.Animation(0, ref icon);
 129         }
 130
 131         private void btnUpdateDesignerRegion_Click(object sender, System.EventArgs e)
 132         {
 133             // Set insert/overstrike mode.
 134             object mode = 1; // Insert mode
 135             SvcStatusBar.SetInsMode(ref mode);
 136
 137             // Display Ln ## Col ## Ch ## information.
 138             object ln = "##", col = "##", ch = "##";
 139             SvcStatusBar.SetLineColChar(ref ln, ref col, ref ch);
 140         }
 141     }
 142 }